Binding of Isaac - Afterbirth+ Lua Reference/Guide
Entity Class Reference
Inheritance diagram for Entity:
EntityBomb EntityEffect EntityFamiliar EntityKnife EntityLaser EntityNPC EntityPickup EntityPlayer

Public Member Functions

table GetData ()
 
 Update ()
 
 Render (Vector Offset)
 
boolean RenderShadowLayer (Vector Offset)
 
 PostRender ()
 
boolean TakeDamage (float Damage, integer Flags, EntityRef Source, integer DamageCountdown)
 
boolean HasMortalDamage ()
 
 Kill ()
 
 Die ()
 
 Remove ()
 
 BloodExplode ()
 
 AddVelocity (Vector Velocity)
 
 MultiplyFriction (float Value)
 
 SetColor (Color Color, integer Duration, integer Priority, boolean Fadeout, boolean Share)
 
const ColorGetColor ()
 
 SetSpriteFrame (string AnimationName, integer FrameNum)
 
 SetSpriteOverlayFrame (string AnimationName, integer FrameNum)
 
 SetSize (float Size, Vector SizeMulti, integer NumGridCollisionPoints)
 
boolean CollidesWithGrid ()
 
boolean IsEnemy ()
 
boolean IsActiveEnemy (boolean includeDead)
 
boolean IsVulnerableEnemy ()
 
boolean IsFlying ()
 
 AddEntityFlags (integer Flags)
 
 ClearEntityFlags (integer Flags)
 
integer GetEntityFlags ()
 
boolean HasEntityFlags (integer Flags)
 
boolean HasFullHealth ()
 
 AddHealth (float HitPoints)
 
 AddPoison (EntityRef Source, integer Duration, float Damage)
 
 AddFreeze (EntityRef Source, integer Duration)
 
 AddSlowing (EntityRef Source, integer Duration, float SlowValue, Color SlowColor)
 
 AddCharmed (integer Duration)
 
 AddConfusion (EntityRef Source, integer Duration, boolean IgnoreBosses)
 
 AddMidasFreeze (EntityRef Source, integer Duration)
 
 AddFear (EntityRef Source, integer Duration)
 
 AddBurn (EntityRef Source, integer Duration, float Damage)
 
 AddShrink (EntityRef Source, integer Duration)
 
 RemoveStatusEffects ()
 
boolean Exists ()
 
boolean IsDead ()
 
boolean IsVisible ()
 
boolean IsInvincible ()
 
boolean CanShutDoors ()
 
boolean IsBoss ()
 
BossId GetBossID ()
 
EntityGetLastParent ()
 
EntityGetLastChild ()
 
boolean HasCommonParentWithEntity (Entity Other)
 
boolean IsFrame (integer Frame, integer Offset)
 
RNGGetDropRNG ()
 
SpriteGetSprite ()
 
EntityPlayer ToPlayer ()
 
EntityEffect ToEffect ()
 
EntityNPC ToNPC ()
 
EntityPickup ToPickup ()
 
EntityFamiliar ToFamiliar ()
 

Public Attributes

float Friction
 
Vector Position
 
Vector Velocity
 
const EntityType Type
 
integer Variant
 
integer SubType
 
EntityType SpawnerType
 
integer SpawnerVariant
 
const ColorSplatColor
 
boolean Visible
 
const VectorPositionOffset
 
integer RenderZOffset
 
boolean FlipX
 
const VectorSpriteOffset
 
const VectorSpriteScale
 
float SpriteRotation
 
Vector SizeMulti
 
float Mass
 
float MaxHitPoints
 
float HitPoints
 
const integer Index
 
const VectorTargetPosition
 
GridCollisionClass GridCollisionClass
 
EntityCollisionClass EntityCollisionClass
 
float CollisionDamage
 
const integer SpawnGridIndex
 
EntityParent
 
EntityChild
 
EntityTarget
 
EntitySpawnerEntity
 
const integer FrameCount
 
const integer InitSeed
 
const integer DropSeed
 
float DepthOffset
 

Static Public Attributes

static Color Color
 
static float Size
 

Member Function Documentation

◆ AddBurn()

Entity::AddBurn ( EntityRef  Source,
integer  Duration,
float  Damage 
)

◆ AddCharmed()

Entity::AddCharmed ( integer  Duration)

◆ AddConfusion()

Entity::AddConfusion ( EntityRef  Source,
integer  Duration,
boolean  IgnoreBosses 
)

◆ AddEntityFlags()

Entity::AddEntityFlags ( integer  Flags)

◆ AddFear()

Entity::AddFear ( EntityRef  Source,
integer  Duration 
)

◆ AddFreeze()

Entity::AddFreeze ( EntityRef  Source,
integer  Duration 
)

◆ AddHealth()

Entity::AddHealth ( float  HitPoints)

◆ AddMidasFreeze()

Entity::AddMidasFreeze ( EntityRef  Source,
integer  Duration 
)

◆ AddPoison()

Entity::AddPoison ( EntityRef  Source,
integer  Duration,
float  Damage 
)

◆ AddShrink()

Entity::AddShrink ( EntityRef  Source,
integer  Duration 
)

◆ AddSlowing()

Entity::AddSlowing ( EntityRef  Source,
integer  Duration,
float  SlowValue,
Color  SlowColor 
)

◆ AddVelocity()

Entity::AddVelocity ( Vector  Velocity)

◆ BloodExplode()

Entity::BloodExplode ( )

◆ CanShutDoors()

boolean Entity::CanShutDoors ( )

◆ ClearEntityFlags()

Entity::ClearEntityFlags ( integer  Flags)

◆ CollidesWithGrid()

boolean Entity::CollidesWithGrid ( )

◆ Die()

Entity::Die ( )

◆ Exists()

boolean Entity::Exists ( )

◆ GetBossID()

BossId Entity::GetBossID ( )

◆ GetColor()

const Color& Entity::GetColor ( )

◆ GetData()

table Entity::GetData ( )

◆ GetDropRNG()

RNG& Entity::GetDropRNG ( )

◆ GetEntityFlags()

integer Entity::GetEntityFlags ( )

◆ GetLastChild()

Entity& Entity::GetLastChild ( )

◆ GetLastParent()

Entity& Entity::GetLastParent ( )

◆ GetSprite()

Sprite& Entity::GetSprite ( )

◆ HasCommonParentWithEntity()

boolean Entity::HasCommonParentWithEntity ( Entity  Other)

◆ HasEntityFlags()

boolean Entity::HasEntityFlags ( integer  Flags)

◆ HasFullHealth()

boolean Entity::HasFullHealth ( )

◆ HasMortalDamage()

boolean Entity::HasMortalDamage ( )

◆ IsActiveEnemy()

boolean Entity::IsActiveEnemy ( boolean  includeDead)

◆ IsBoss()

boolean Entity::IsBoss ( )

◆ IsDead()

boolean Entity::IsDead ( )

◆ IsEnemy()

boolean Entity::IsEnemy ( )

◆ IsFlying()

boolean Entity::IsFlying ( )

◆ IsFrame()

boolean Entity::IsFrame ( integer  Frame,
integer  Offset 
)

◆ IsInvincible()

boolean Entity::IsInvincible ( )

◆ IsVisible()

boolean Entity::IsVisible ( )

◆ IsVulnerableEnemy()

boolean Entity::IsVulnerableEnemy ( )

◆ Kill()

Entity::Kill ( )

◆ MultiplyFriction()

Entity::MultiplyFriction ( float  Value)

◆ PostRender()

Entity::PostRender ( )

◆ Remove()

Entity::Remove ( )

◆ RemoveStatusEffects()

Entity::RemoveStatusEffects ( )

◆ Render()

Entity::Render ( Vector  Offset)

◆ RenderShadowLayer()

boolean Entity::RenderShadowLayer ( Vector  Offset)

◆ SetColor()

Entity::SetColor ( Color  Color,
integer  Duration,
integer  Priority,
boolean  Fadeout,
boolean  Share 
)

◆ SetSize()

Entity::SetSize ( float  Size,
Vector  SizeMulti,
integer  NumGridCollisionPoints 
)

◆ SetSpriteFrame()

Entity::SetSpriteFrame ( string  AnimationName,
integer  FrameNum 
)

◆ SetSpriteOverlayFrame()

Entity::SetSpriteOverlayFrame ( string  AnimationName,
integer  FrameNum 
)

◆ TakeDamage()

boolean Entity::TakeDamage ( float  Damage,
integer  Flags,
EntityRef  Source,
integer  DamageCountdown 
)

◆ ToEffect()

EntityEffect Entity::ToEffect ( )

◆ ToFamiliar()

EntityFamiliar Entity::ToFamiliar ( )

◆ ToNPC()

EntityNPC Entity::ToNPC ( )

◆ ToPickup()

EntityPickup Entity::ToPickup ( )

◆ ToPlayer()

EntityPlayer Entity::ToPlayer ( )

◆ Update()

Entity::Update ( )

Member Data Documentation

◆ Child

Entity& Entity::Child

◆ CollisionDamage

float Entity::CollisionDamage

◆ Color

Color Entity::Color
static

◆ DepthOffset

float Entity::DepthOffset

◆ DropSeed

const integer Entity::DropSeed

◆ EntityCollisionClass

EntityCollisionClass Entity::EntityCollisionClass

◆ FlipX

boolean Entity::FlipX

◆ FrameCount

const integer Entity::FrameCount

◆ Friction

float Entity::Friction

◆ GridCollisionClass

GridCollisionClass Entity::GridCollisionClass

◆ HitPoints

float Entity::HitPoints

◆ Index

const integer Entity::Index

◆ InitSeed

const integer Entity::InitSeed

◆ Mass

float Entity::Mass

◆ MaxHitPoints

float Entity::MaxHitPoints

◆ Parent

Entity& Entity::Parent

◆ Position

Vector Entity::Position

◆ PositionOffset

const Vector& Entity::PositionOffset

◆ RenderZOffset

integer Entity::RenderZOffset

◆ Size

float Entity::Size
static

◆ SizeMulti

Vector Entity::SizeMulti

◆ SpawnerEntity

Entity& Entity::SpawnerEntity

◆ SpawnerType

EntityType Entity::SpawnerType

◆ SpawnerVariant

integer Entity::SpawnerVariant

◆ SpawnGridIndex

const integer Entity::SpawnGridIndex

◆ SplatColor

const Color& Entity::SplatColor

◆ SpriteOffset

const Vector& Entity::SpriteOffset

◆ SpriteRotation

float Entity::SpriteRotation

◆ SpriteScale

const Vector& Entity::SpriteScale

◆ SubType

integer Entity::SubType

◆ Target

Entity& Entity::Target

◆ TargetPosition

const Vector& Entity::TargetPosition

◆ Type

const EntityType Entity::Type

◆ Variant

integer Entity::Variant

◆ Velocity

Vector Entity::Velocity

◆ Visible

boolean Entity::Visible